ARDK for Android/com.nianticlabs.ardk

Package-level declarations

Types

Name	Summary
AnchorTrackingState	[androidJvm] enum AnchorTrackingState : Enum<AnchorTrackingState> Represents the current tracking state of a VPS anchor.
AnchorTrackingStateReason	[androidJvm] enum AnchorTrackingStateReason : Enum<AnchorTrackingStateReason> Provides additional context about why an anchor is in a particular tracking state.
AnchorUpdate	[androidJvm] data class AnchorUpdate(val uuid: UUID, val anchorToLocalTrackingTransform: Pose, val trackingState: AnchorTrackingState, val trackingStateReason: AnchorTrackingStateReason, val trackingConfidence: Float, val timestampMs: Long) Contains the latest tracking information for a VPS anchor.
ArdkConfiguration	[androidJvm] object ArdkConfiguration Kotlin configuration structures mirroring Swift ArdkSession.Configuration.
ArdkFeatureAlreadyInitializedStatusException	[androidJvm] class ArdkFeatureAlreadyInitializedStatusException(message: String? = null) : ArdkStatusException Thrown when a feature is already initialized. Corresponds to ARDKStatus.FEATURE_ALREADY_INITIALIZED.
ArdkFeatureNotInitializedStatusException	[androidJvm] class ArdkFeatureNotInitializedStatusException(message: String? = null) : ArdkStatusException Thrown when a required feature has not been initialized. Corresponds to ARDKStatus.FEATURE_NOT_INITIALIZED.
ArdkInvalidArgumentStatusException	[androidJvm] class ArdkInvalidArgumentStatusException(message: String? = null) : ArdkStatusException Thrown when a native argument has an invalid value. Corresponds to ARDKStatus.INVALID_ARGUMENT.
ArdkInvalidHandleStatusException	[androidJvm] class ArdkInvalidHandleStatusException(message: String? = null) : ArdkStatusException Thrown when a native handle is invalid or has been destroyed. Corresponds to ARDKStatus.INVALID_ARDK_HANDLE.
ArdkInvalidOperationStatusException	[androidJvm] class ArdkInvalidOperationStatusException(message: String? = null) : ArdkStatusException Thrown when a native operation is not valid in the current state. Corresponds to ARDKStatus.INVALID_OPERATION.
ArdkLogCallback	[androidJvm] fun interface ArdkLogCallback Functional interface for receiving log messages from ARDK.
ArdkNullArgumentStatusException	[androidJvm] class ArdkNullArgumentStatusException(message: String? = null) : ArdkStatusException Thrown when a required native argument is null. Corresponds to ARDKStatus.NULL_ARGUMENT.
ARDKResult	[androidJvm] sealed class ARDKResult<out TData, out TError : ErrorCodeProvider> ResultDeprecated wrapper for ARDK operations that can succeed or fail.
ARDKSession	[androidJvm] class ARDKSession : Closeable Creates a new ARDK instance with the provided API key.
ARDKStatus	[androidJvm] enum ARDKStatus : Enum<ARDKStatus> Status codes returned by ARDK operations.
ArdkStatusException	[androidJvm] open class ArdkStatusException(val status: ARDKStatus, message: String? = null) : Exception Base class for all ARDK-specific exceptions originating from the native layer.
ArdkUnknownStatusException	[androidJvm] class ArdkUnknownStatusException(message: String? = null) : Exception Thrown when an internal, unrecoverable error occurs in the native layer. that is unexpected
AreaTarget	[androidJvm] data class AreaTarget(val coverageArea: CoverageArea, val localizationTarget: LocalizationTarget)
AsyncResult	[androidJvm] sealed class AsyncResult<out TData, out TError : ErrorCodeProvider> Represents the final result of a completed asynchronous operation, which can either be a success, a failure, or a timeout. * This is the public-facing result type returned by suspend functions. It intentionally omits an "in-progress" state, guaranteeing that the operation has reached a terminal state.
AwarenessContext	[androidJvm] data class AwarenessContext(val frameId: Long, val timestampMs: Long, val pose: Pose, val CameraIntrinsics: CameraIntrinsics)
AwarenessFeatureMode	[androidJvm] enum AwarenessFeatureMode : Enum<AwarenessFeatureMode>
AwarenessImageParams	[androidJvm] class AwarenessImageParams(val extrinsics: Pose, val intrinsics: CameraIntrinsics, val imageWidth: Int, val imageHeight: Int) Describes inferred image results.
AwarenessStatus	[androidJvm] enum AwarenessStatus : Enum<AwarenessStatus> , ErrorCodeProvider
CameraIntrinsics	[androidJvm] open class CameraIntrinsics(focalLengthArray: FloatArray = FloatArray(2), principalPointArray: FloatArray = FloatArray(2), imageDimensionsArray: IntArray = IntArray(2)) Camera intrinsics. This is a copy of the ARCore CameraIntrinsics class.
CameraIntrinsicsFromARCore	[androidJvm] class CameraIntrinsicsFromARCore(arcoreIntrinsics: CameraIntrinsics) : CameraIntrinsics
Compass	[androidJvm] data class Compass(val timestampMs: Long, val headingAccuracy: Float, val magneticHeading: Float, val rawDataX: Float, val rawDataY: Float, val rawDataZ: Float, val trueHeading: Float)
CoverageArea	[androidJvm] data class CoverageArea(val shape: Array<LatLng>, val center: LatLng, val localizationTargets: Array<String>, val localizability: Localizability)
DepthBuffer	[androidJvm] data class DepthBuffer(val frameId: Long, val timestampMs: Long, val pose: Pose, val intrinsics: CameraIntrinsics, val orientation: Orientation, val disparityMin: Float, val disparityMax: Float, val image: FloatArray, val imageWidth: Int, val imageHeight: Int) Depth result from ARDK's Depth System after computing disparity.
DepthConfig	[androidJvm] class DepthConfig(var framerate: Int = 0, var featureMode: AwarenessFeatureMode = AwarenessFeatureMode.UNSPECIFIED) Configuration parameters for ARDK's Depth System.
DeviceMappingConfig	[androidJvm] class DeviceMappingConfig(var trackingEdgesDisabled: Boolean = false, var slickLearnedFeaturesEnabled: Boolean = false, var slickMapperFrameRate: Int = 0, var splitterMaxDistanceMeters: Float = 0.0f, var splitterMaxDurationSeconds: Float = 0.0f)
ErrorCodeProvider	[androidJvm] interface ErrorCodeProvider
ErrorFactory	[androidJvm] interface ErrorFactory<E : ErrorCodeProvider>
FeatureStatus	[androidJvm] enum FeatureStatus : Enum<FeatureStatus>
FrameData	[androidJvm] class FrameData(val cameraTimestampMs: Long, val frameId: Long) Container for all frame data sent to ARDK for processing.
GeolocationData	[androidJvm] data class GeolocationData(val latitude: Double, val longitude: Double, val altitude: Double, val heading: Double, val orientationEdn: FloatArray)
Image	[androidJvm] sealed class Image
ImageType	[androidJvm] enum ImageType : Enum<ImageType>
InputDataFlags	[androidJvm] enum InputDataFlags : Enum<InputDataFlags>
LatLng	[androidJvm] data class LatLng(val lat: Double, val lng: Double) Geographic coordinates representing latitude and longitude.
Localizability	[androidJvm] enum Localizability : Enum<Localizability>
LocalizationTarget	[androidJvm] data class LocalizationTarget(val identifier: String, val center: LatLng, val name: String, val hintImageUrl: String, val defaultAnchorPayload: String)
MapMetadata	[androidJvm] data class MapMetadata(val points: FloatArray, val errors: FloatArray, val pointsCount: Int, val usesLearnedFeatures: Boolean)
MeshData	[androidJvm] data class MeshData(val vertices: FloatArray, val uvs: FloatArray?, val indices: IntArray, val normals: FloatArray?)
MeshDownloaderData	[androidJvm] data class MeshDownloaderData(var meshData: MeshData, var imageData: ByteArray, var transform: FloatArray)
MeshDownloaderError	[androidJvm] enum MeshDownloaderError : Enum<MeshDownloaderError> , ErrorCodeProvider
MeshingConfig	[androidJvm] class MeshingConfig(var frameRate: UInt, var fuseKeyframesOnly: Boolean = false, var maximumIntegrationDistance: Float = 0.0f, var voxelSize: Float = 0.0f, var enableDistanceBasedVolumetricCleanup: Boolean = false, var numVoxelLevels: Int = 0, var meshBlockSize: Float = 0.0f, var meshCullingDistance: Float = 0.0f, var disableMeshDecimation: Boolean = true, var filterMeshWithSemantics: Boolean = false, var enableAllowlist: Boolean = false, var packedAllowlist: UInt, var enableBlocklist: Boolean = false, var packedBlocklist: UInt)
MeshingUpdateInfo	[androidJvm] data class MeshingUpdateInfo(val ids: LongArray, val updated: ByteArray)
Orientation	[androidJvm] enum Orientation : Enum<Orientation> Device orientation when capturing camera frames.
PathConfig	[androidJvm] data class PathConfig(val publicApplicationPath: String? = null, val privateApplicationPath: String? = null, val tmpPath: String? = null) Optional path overrides mirroring native ARDK_PathConfig. Null or empty values mean: let native auto-detect paths.
RecordingInfo	[androidJvm] data class RecordingInfo(val frameCount: Int)
ScannerConfig	[androidJvm] class ScannerConfig(var framerate: Int = 0, var enableRaycastVisualization: Boolean = false, var enableVoxelVisualization: Boolean = false, var raycastWidth: Int = 0, var raycastHeight: Int = 0, var nearDepth: Float = 0.02f, var farDepth: Float = 0.0f, var voxelSize: Float = 0.0f, var basePath: String? = null, var scanTargetId: String? = null, var useArdkDepthsIfPlatformUnavailable: Boolean = false, var enableFullResolution: Boolean = false, var fullResolutionFramerate: Int = 0) Configuration parameters for scanning functionality.
ScanSaveError	[androidJvm] enum ScanSaveError : Enum<ScanSaveError> , ErrorCodeProvider Error codes that can be returned when a scan fails to save.
ScanSaveInfo	[androidJvm] data class ScanSaveInfo(val scanId: String?, val savePath: String?, state: ScanSaveState) Information about a saved scan.
ScanSaveState	[androidJvm] enum ScanSaveState : Enum<ScanSaveState> Enumeration of possible scan recording save states.
SessionBase	[androidJvm] abstract class SessionBase<T : SessionBase<T>> : Closeable
UUID	[androidJvm] typealias UUID = ByteArray
VPSConfig	[androidJvm] class VPSConfig(var enableContinuousLocalization: Boolean = false, val cloudInitialRequestsPerSecond: Float = 1.0f, val cloudContinuousRequestsPerSecond: Float = 0.2f, val enableTemporalFusion: Boolean = false, val enableInterpolation: Boolean = false, val jpegCompressionQuality: Int = 50, val enableDeviceMapLocalization: Boolean = false, val enableVPSDebugger: Boolean = false, val enableGpsCorrectionForContinuousLocalization: Boolean = true) Configuration structure for the VPS session.
VpsCoverageError	[androidJvm] enum VpsCoverageError : Enum<VpsCoverageError> , ErrorCodeProvider
VpsGraphOperationError	[androidJvm] enum VpsGraphOperationError : Enum<VpsGraphOperationError> , ErrorCodeProvider Error codes for VPS graph operations.
WPSConfig	[androidJvm] class WPSConfig(var enableSmoothing: Boolean = true, val framerate: Int = 120) Configuration structure for the WPS session.
WPSError	[androidJvm] enum WPSError : Enum<WPSError> , ErrorCodeProvider Represents the current error status of the WPS (World Positioning System) feature.
WPSLocation	[androidJvm] data class WPSLocation(val referenceLatitudeDegrees: Double, val referenceLongitudeDegrees: Double, val referenceAltitudeMetres: Double, val trackingToRelativeEdn: Pose) Contains world positioning data from the WPS (World Positioning System).